home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 11 / Cream of the Crop 11-2.iso / extra_2 / nadir11.zip / README.TXT < prev    next >
Text File  |  1995-11-08  |  14KB  |  361 lines
  1. nadir11.zip     Macro & Procedural Language for DOS & Windows
  2.  
  3.  
  4. The Nadir program is provided as shareware with the following limitations:
  5.  
  6. The program is shareware and is not to be resold or distributed for sale
  7. with other programs which are for sale.  The shareware version of Nadir 
  8. may be shared with others as long as the contents of the product are not
  9. modified in any way.  There is no warranty or claim of fitness or 
  10. reliability.  The program is distributed AS IS, and as such the author 
  11. shall not be held liable for any loss of data, down time, loss of revenue
  12. or any other direct or indirect damage or claims caused by this program.
  13.  
  14.  
  15. If you want to register Nadir, fill out the enclosed order.frm
  16. and send to the address below.  A copy of the commercial version and
  17. a printed manual will be sent to you.
  18.  
  19. Enexe Systems
  20. P.O. Box 771
  21. Ashgrove.  4060
  22. Australia.
  23.  
  24.  
  25. If you have any comments or questions, please send mail to the above 
  26. address or email to ENEXE@mailbox.uq.edu.au
  27.  
  28.  
  29.  
  30. A Description of Nadir
  31. ======================
  32.  
  33. Nadir is an interpreted programming language.  It is designed to be 
  34. simple yet intelligent, to reuse as many of its algorithms as possible 
  35. to produce a small yet powerful programming system.
  36.  
  37. It combines macro generation capabilities, with the ability to
  38. write procedural functions.  With it you can generate code for any
  39. language, analyse and manipulate text files, write database style
  40. applications that run unchanged under DOS and Windows, or use it
  41. as a calculator.
  42.  
  43. The name Nadir, the opposite of the zenith, is used to signify a
  44. starting point, a minimal set of rules and functions upon which things
  45. can be built.  It will appeal to students, professional programmers,
  46. and the home enthusiast who wants a no frills programming language that
  47. is easy or useful to learn because its syntax is based on C.
  48.  
  49. The base nucleus of Nadir comprises a number of modules that perform
  50. language parsing, language interpretation, error handling, and a set of
  51. inbuilt intrinsic functions for performing string, numeric and date
  52. maniplation, and the control of data files and the symbols in them.
  53. The nucleus is written in c, and has been ported to run under DOS and
  54. Windows.
  55.  
  56. Other modules of intrinsic functions have been written to perform
  57. Screen Dialogues and Report Formatting.  These functions have been
  58. written to perform under DOS in text mode and Windows.  When an
  59. application is written using these functions, it will work under DOS
  60. and Windows without change.
  61.  
  62. A runtime version of Nadir is provided with the commercial version.  A
  63. system developed using the commercial version may be installed at a
  64. user site with the runtime version of Nadir.  No royalty fees are
  65. required to install the runtime version at a user site.
  66.  
  67.  
  68.  
  69. How to run the Demonstration
  70. ============================
  71.  
  72. The DOS version will run on any version above DOS 3.3 with around 300K
  73. of real memory available.  Nadir will run under Windows version 3.0 and
  74. above.
  75.  
  76. The following instructions assume that the Nadir shareware version has
  77. been installed on c: drive in a directory called nadir.
  78.  
  79. Please note that the switch names and macro names, like -c, -D, -e and
  80. InvMenu are case sensitive and therefore must be keyed in exactly as
  81. shown in the examples.
  82.  
  83.  
  84. Under DOS
  85. =========
  86.  
  87. Either
  88.  
  89.      c:\nadir\demo
  90.  
  91. Or change the default directory to where Nadir was installed, and key
  92. in the command to start the demo.
  93.  
  94.      c:
  95.      cd \nadir
  96.      n -c -eDemo
  97.  
  98. The third line runs the n.exe program, specifying that on error the
  99. program should automatically restart (cycle), and that the macro called
  100. Demo should be executed.  To run the sample Invoicing Program, specify
  101. -eInvMenu, and for the Phone List program, specify -ePhoneList.
  102.  
  103.  
  104. Under Windows
  105. =============
  106.  
  107. Either execute the following program.  Do this by double clicking on 
  108. windemo.exe in the File Manager, or by specifying the following when 
  109. choosing File Run in Program Manager.
  110.  
  111.      c:\nadir\windemo
  112.  
  113. Or create a new program item using the File, New options in the Program
  114. Manager.  The command line should be
  115.  
  116.      c:\nadir\nw -c -eDemo -Dc:\nadir -Tc:\nadir
  117.  
  118. This command specifies nw.exe which is the Windows version executable.
  119. The -D switch tells Nadir to look for data files in the c:\nadir
  120. directory, while -T specifies that temporary work files are created in
  121. c:\nadir.  The alternative to specifying -D and -T in Windows 3.1 is to
  122. specify the working directory as c:\nadir.
  123.  
  124.  
  125. The DOS version of the program has been written to closely follow the
  126. operation of Windows dialogue boxes.  Some Windows features are not
  127. present.  The mouse is supported, if a mouse driver is loaded before
  128. running Nadir.  The keyboard functions are the same as under Windows,
  129. eg to close a dialogue box, use <Alt>F4.
  130.  
  131.  
  132.  
  133. Differences between Shareware and Commercial Versions
  134. =====================================================
  135.  
  136. Differences have been built into the Shareware version of the product
  137. as an incentive to register the product.  All of the functionality of 
  138. the product is present in the Shareware version.
  139.  
  140.  
  141.  
  142. Feature                                           Shareware     Commercial
  143.  
  144.  
  145. The number of times the Windows version of the    1 time        16 times
  146. program can be started simultaneously.
  147.  
  148. The maximum size of a key, or symbol name.        64 bytes      128 bytes
  149.  
  150. The permissible number of levels in the b-tree    3 levels      10 levels
  151. structure that is used to store symbol names
  152. and values.
  153.  
  154. The number of levels in the b-tree affects the
  155. total number of symbols that can be stored in
  156. a data file.
  157.  
  158. This limitation, together with the block size
  159. limitation of 512 bytes will allow moderate
  160. amounts of data to be stored in the symbol
  161. table files.
  162.  
  163. In the Key File Utility, and functions that       CANNOT        CAN specify
  164. deal with creating and opening Symbol files,      specify       blkSize and
  165. the block size (size of b-tree node) and the      blkSize and   buffCnt.
  166. number of buffers may be defined.                 buffCnt.
  167.  
  168. By specifying a larger block size, longer         blkSize is
  169. string values can be stored.  Specifying          always 512
  170. buffCnt allows the user to tune system            bytes.
  171. performance.
  172.  
  173. Ability to open Symbol Files simultaneously.      CANNOT        CAN share
  174. When files are opened shared, locking             share         files with
  175. conventions can be employed to manage access.                   other and
  176.                                                                 manage file
  177. With the Shareware version, no file can be                      locking.
  178. shared.  You can start one DOS session, or one
  179. Windows session, but not at the same time.
  180.  
  181. With the Commercial version, you can start 16
  182. tasks in a Windows session, and any number of
  183. DOS sessions in DOS boxes under Windows, all
  184. opening and sharing files.  If the files are
  185. on a Network Server, files may be shared with
  186. other workstation users on the network.
  187.  
  188. The ability to open Symbol Tables.  The system    CAN open 7    CAN open 7
  189. has some fixed symbol tables.  They are :-        fixed         fixed and
  190.                                                   symbol        16 user
  191. mdat - Macro definitions                          files.        defined
  192. mlib - Macro library                                            symbol
  193. univ - Universal data, permanent                                files.
  194. glob - Global data, temporary for an
  195.        invokation of the program.
  196. parm - Parameter file, permanent.
  197. data - General purpose permanent data file.
  198. temp - General purpose temporary data file.
  199.  
  200. With the Shareware version, only the fixed
  201. files can be opened.
  202.  
  203. With the Commercial version, the fixed files
  204. as well as 16 user defined files can be
  205. opened.
  206.  
  207. The size of the stack that is used to evaluate    2048 bytes.   Defaults to
  208. expressions and hold fuction arguments is                       4096 bytes,
  209. fixed in the Shareware Version.  In the                         can be up
  210. Commercial version, a startup parameter allows                  to 64K.
  211. the user to override the default value.
  212.  
  213. Specifying larger sizes allows functions to be
  214. more complex and manipulate more and larger
  215. values.
  216.  
  217. The size of the stack that is used to store       2048 bytes.   Defaults to
  218. the values of local variables in functions is                   4096 bytes,
  219. fixed in  the Shareware Version.  In the                        can be up
  220. Commercial version, a startup parameter allows                  to 64K.
  221. the user to override the default value.
  222.  
  223. The maximum length of a string field.             512 bytes.    2048 bytes.
  224.  
  225. A reference manual describing the language and    Text file     Complete
  226. the intrinsic functions.                          of Language   hardcopy
  227.                                                   Reference     manual
  228.                                                   supplied.     supplied.
  229.  
  230. A runtime version of the system.  This is for     NOT           Supplied.
  231. program developers that want to distribute        supplied.
  232. copies of their programs.  The runtime version
  233. is the same as the commercial version, except
  234. that functions and macros cannot be compiled.
  235.  
  236. Support to provide program fixes.                 NOT           Supplied.
  237.                                                   supplied.
  238.  
  239. Welcome to Nadir dialogue box displayed before    Supplied.     NOT
  240. the first dialogue box for an application is                    supplied.
  241. shown.
  242.  
  243.  
  244.  
  245. Description of Files
  246. ====================
  247.  
  248. readme.txt      This file.  An Introduction to Nadir
  249.  
  250. file_id.diz    Brief description of NADIR.
  251.  
  252. order.frm       Details on how to order the commercial version of
  253.                 Nadir.
  254.  
  255. demo.exe        Program to run the demonstration programs under DOS.
  256.                 Runs n.exe with some parameters.
  257.  
  258. windemo.exe     Program to run the demonstration programs under
  259.                 Windows.  Runs nw.exe with some parameters.
  260.  
  261. n.exe           The DOS version of Nadir.
  262.  
  263. nw.exe          The Windows version of Nadir.
  264. nsys.dll
  265.  
  266. stu.exe         Symbol Table Utility Program.  This DOS program is used
  267.                 to maintain and dump the contents of the symbol table
  268.                 files.
  269.  
  270. comline.bat     Batch files used by the sample application.  They are
  271. compause.bat    used in the DOS version to implement backup and restore
  272.                 procedures.
  273.  
  274. dbrowser.bat    The most basic (and base) text browse utility.  There
  275.                 is a system parameter that allows the definition of a
  276.                 text browser for use by report printing.
  277.  
  278. univ.dat        Universal data file, that has sample data for the
  279.                 demonstration application.
  280.  
  281. parm.dat        Parameter data file.
  282.  
  283. inv.dat         Invoice data file contains a few example invoices.
  284.  
  285. mdat.dat        Macro Data file contains the compiled macro code, and
  286.                 any definitions necessary for the running of the sample
  287.                 application.  The contents of this file can be
  288.                 regenerated with makeall.bat.
  289.  
  290. makeall.bat     A batch file which removes the existing mdat.dat file,
  291.                 and recompiles all the source code provided.
  292.  
  293. demo.n          The demonstration program.
  294.  
  295. invmenu.n       Invoicing Application Menu.
  296.  
  297. inv.n           Invoice Entry.
  298.  
  299. client.n        Client Maintenance.
  300.  
  301. invp.n          Invoice Printing.
  302.  
  303. invr.n          Invoice Reporting.
  304.  
  305. invs.n          Invoicing Summary Print.
  306.  
  307. invpar.n        Modify Invoicing system parameters.
  308.  
  309. type.n          Demonstration of the code generation capabilities of
  310.                 the language.  Used to define description type tables
  311.                 with a code and a description.  Is invoked to generate
  312.                 the code for Property Types and Valuation Types
  313.                 maintenance.
  314.  
  315. phonel.n        The Phone List program.  A different example of how
  316.                 data can be presented and modified.
  317.  
  318. bkup.n          Backup and Restore to diskette.
  319.  
  320. list.n          General purpose listing program to list symbols in a
  321.                 symbol table.
  322.  
  323. mtce.n          General purpose maintenance that can be used to add,
  324.                 modify or delete any symbol in any symbol table.
  325.  
  326. prt.n           Modify definition of printers, the size of paper, and
  327.                 start and end escape sequences.
  328.  
  329. scrattr.n       Modifiy screen colours and characters for DOS version.
  330.                 This demonstrates the code generation capabilities of
  331.                 Nadir.
  332.  
  333. detab.n         Utility to replace tabs with spaces in a file.
  334.  
  335. ute.n           General purpose utility functions.
  336.  
  337. load.n          Symbol file unload and reload utilities.
  338.  
  339. rand.n          Random number generation.
  340.  
  341. spar.n          Modify system parameters.
  342.  
  343. args.n          Test and demonstration code as to how the arguments to
  344.                 a macro may be accessed.
  345.  
  346. file.n          Show how text files can be opened, read and written.
  347.  
  348. multied.n       Demonstrate multi line edit fields.
  349.  
  350. process.n       Demonstrate the Process intrinsic function.  This
  351.                 function allows for code to be generated, compiled and
  352.                 run under program control.
  353.  
  354. xtree.n         Front end dialogue box to run a DOS application.
  355.                 Demonstation dialogue box with permanent data kept on a
  356.                 data file for next invokation.
  357.  
  358. winput.n        Test program for the Screen Dialogue objects such as
  359.                 text input fields, push buttons, radio buttons, check
  360.                 boxes, combo boxes, select boxes, menus and prompts.
  361.